Cream of the Crop 22

home *** CD-ROM | disk | FTP | other *** search

/ Cream of the Crop 22 / Cream of the Crop 22.iso / editor / jmedia20.zip / COMMANDS.DOC < prev next >

Wrap

Text File | 1996-11-01 | 45KB | 1,296 lines

This is a list of all the available commands JMedia can use. Commands marked as EXTENDED cannot be used for creating RIP menus for BBSes. Internal, Macro, and all the other NON extended commands can be used for both JMedia applications and RIP BBS menus. Commands that contain x2 and y2 co-ordinates such as the Rectangle and Bar command can use a "+" in front of the x2 and y2 co-ordinate to indicate a width and height relative to the x,y co-ordinates. --------------------------------------------------------------------- SetDimensions (INTERNAL COMMAND) --------------------------------------------------------------------- Function: Segments the screen into smaller dimensions Parameter(s): oldWidth oldHeight newWidth newHeight Example: 640 350 80 43 The SetDimensions command effects most graphics commands that contain co-ordinates, it does not effect the TextWindow command. All graphic commands following the SetDimensions command will use the new values to calculate real co-ordinates. The command can be reset at any time throughout your JMedia scripts by specifying new dimensions. To reset the command for single pixel precision just type SetDimensions 1 1 1 1 --------------------------------------------------------------------- TextWindow --------------------------------------------------------------------- Function: Creates a Text Window by specifying size and font to use Parameter(s): x y x2 y2 wrap font Example: TextWindow 0 0 79 42 0 0 TextWindow 0 0 +80 +43 NO 0 TextWindow 0 0 +80 +43 YES 0 Font Font Size X Range Y Range ------------------------------------------ 0 8x8 *0-79 *0-42 1 7x8 *0-90 *0-42 2 8x14 *0-79 *0-24 3 7x14 *0-90 *0-24 4 16x14 *0-39 *0-24 The wrap parameter is used if you want text that exceeds the width of the text window to continue on into the next line instead of being truncated. (*) Max range can be up to 255 rows/columns, the numbers listed are the max used when creating BBS RIP screens. --------------------------------------------------------------------- ViewPort --------------------------------------------------------------------- Function: Defines the graphics window Parameter(s): x y x2 y2 Example: ViewPort 0 0 649 199 ViewPort 0 0 +650 +200 --------------------------------------------------------------------- ResetWindows --------------------------------------------------------------------- Function: Clears both the Graphics and Text Windows by resetting them to full screen Parameter(s): none Example: ResetWindows --------------------------------------------------------------------- EraseWindow --------------------------------------------------------------------- Function: Clears the text window Parameter(s): none Example: EraseWindow --------------------------------------------------------------------- EraseView --------------------------------------------------------------------- Function: Clears the graphics window Parameter(s): none Example: EraseView --------------------------------------------------------------------- GotoXY --------------------------------------------------------------------- Function: Moves the text cursor to x,y co-ordinates within the text window area row & column in Text Window Parameter(s): x y Example: GotoXY 0 0 GotoXY 79 42 --------------------------------------------------------------------- Home --------------------------------------------------------------------- Function: Moves text cursor to 0,0 co-ordinates within the text window Parameter(s): none Example: Home --------------------------------------------------------------------- EraseEOL --------------------------------------------------------------------- Function: Erase the current line from cursor position to the end of the line Parameter(s): none Example: EraseEOL --------------------------------------------------------------------- Color --------------------------------------------------------------------- Function: Sets the drawing color for some of graphics commands Parameter(s): Color Example: Color 1 Color Blue Value Color -------------------------- 0 Black 1 Blue 2 Green 3 Cyan 4 Red 5 Magenta 6 Brown 7 LightGray 8 DarkGray 9 LightBlue 10 LightGreen 11 LightCyan 12 LightRed 13 LightMagenta 14 Yellow 15 White NOTE: Some graphic commands are not effected by the color function, you must use the SetFillStyle or SetFillPattern functions. --------------------------------------------------------------------- SetPalette --------------------------------------------------------------------- Function: Sets a new the 16 color palette. Each color value must range from 0 to 63. Parameter(s): v1 v2 v3 v4 v5 v6 v7 v8 v9 v10 v11 v12 v13 v14 v15 v16 Example: SetPalette 4 6 0 2 54 44 21 3 7 9 12 60 61 31 33 45 --------------------------------------------------------------------- OnePalette --------------------------------------------------------------------- Function: Sets one color of the 16 color palette Parameter(s): ColorNumber Value Example: OnePalette 0 44 --------------------------------------------------------------------- WriteMode --------------------------------------------------------------------- Function: Sets the drawing mode for some of the graphic commands Parameter(s): Mode Example: WriteMode 0 WriteMode 1 WriteMode CopyPut WriteMode XorPut --------------------------------------------------------------------- Move --------------------------------------------------------------------- Function: Moves the graphics pen position to a new location Parameter(s): x y Example: Move 10 50 --------------------------------------------------------------------- Text --------------------------------------------------------------------- Function: Print text in the graphics window using the current font and color at the current pen position Parameter(s): TextString Example: Text Hello --------------------------------------------------------------------- TextXY --------------------------------------------------------------------- Function: print text in the graphics window at x,y co-ordinates Parameter(s): x y TextString Example: TextXY 100 100 Hello Everybody --------------------------------------------------------------------- FontStyle --------------------------------------------------------------------- Function: Sets current graphics font style, orientation and size. Parameter(s): font direction size Example: FontStyle 1 0 5 FontStyle Triplex HorizDir 5 FontStyle Triplex VertDir 5 Font FontName ----------------- 0 Default 1 Triplex 2 Small 3 SansSerif 4 Gothic 5 Script 6 Simplex 7 Triplex 8 Complex 9 European 10 Bold For the Size parameter use values 1 to 10 --------------------------------------------------------------------- Pixel --------------------------------------------------------------------- Function: Plots a pixel at the specified x,y co-ordinates using the current color Parameter(s): x y Example: Pixel 50 50 --------------------------------------------------------------------- Line --------------------------------------------------------------------- Function: Plots a line using the current color and line style Parameter(s): x y x2 y2 Example: Line 50 50 100 100 Line 50 50 +50 +50 --------------------------------------------------------------------- Rectangle --------------------------------------------------------------------- Function: Plots a rectangle using the current color line style Parameter(s): x y x2 y2 Example: Rectangle 50 50 100 100 Rectangle 50 50 +50 +50 --------------------------------------------------------------------- Bar --------------------------------------------------------------------- Function: Plots a filled rectangle using the current fill color and pattern Parameter(s): x y x2 y2 Example: Bar 50 50 100 100 Bar 50 50 +50 +50 --------------------------------------------------------------------- Circle --------------------------------------------------------------------- Function: Plots a circle using the current color and line thickness Parameter(s): x y radius Example: Circle 100 100 50 --------------------------------------------------------------------- Oval --------------------------------------------------------------------- Function: Plots an elliptical arc using the current color and line style Parameter(s): x y StartAngle EndAngle xradius yradius Example: Oval 100 100 0 360 50 60 --------------------------------------------------------------------- FilledOval --------------------------------------------------------------------- Function: Plots a filled ellipse using the current color and fill pattern Parameter(s): x y xradius yradius Example: FilledOval 100 100 50 60 --------------------------------------------------------------------- Arc --------------------------------------------------------------------- Function: Plots a circular arc using the current color and line thickness Parameter(s): x y StartAngle EndAngle radius Example: Arc 100 100 90 180 50 --------------------------------------------------------------------- OvalArc --------------------------------------------------------------------- Function: Plots an elliptical arc Parameter(s): x y StartAngle EndAngle xradius yradius Example: OvalArc 100 100 90 180 50 60 --------------------------------------------------------------------- PieSlice --------------------------------------------------------------------- Function: Plots a circular pie slice Parameter(s): x y StartAngle EndAngle radius Example: PieSlice 100 100 90 180 50 --------------------------------------------------------------------- OvalPieSlice --------------------------------------------------------------------- Function: Plots an elliptical pie slice Parameter(s): x y StartAngle EndAngle xradius yradius Example: OvalPieSlice 100 100 90 180 50 60 --------------------------------------------------------------------- Bezier --------------------------------------------------------------------- Function: Plots a bezier curve using the current color and line style Parameter(s): x y x2 y2 x3 y3 x4 y4 Segments Example: Bezier 392 136 388 133 380 135 378 141 10 --------------------------------------------------------------------- Polygon --------------------------------------------------------------------- Function: Plots a polygon using the current color and line style Parameter(s): x y x2 y2 ... Example: Polygon 10 10 20 10 30 40 Polygon 10 10 20 10 \ 30 40 Polygon 10 10 \ 20 10 \ 30 40 The backslash can be used at the end of the line to indicate that more x,y co-ordinates continue in the next line --------------------------------------------------------------------- FillPolygon --------------------------------------------------------------------- Function: Plots a filled polygon using the current color and fill pattern Parameter(s): x y x2 y2 ... Example: FillPolygon 10 10 20 10 30 40 FillPolygon 10 10 20 10 \ 30 40 FillPolygon 10 10 \ 20 10 \ 30 40 The backslash can be used at the end of the line to indicate that more x,y co-ordinates continue in the next line --------------------------------------------------------------------- Polyline --------------------------------------------------------------------- Function: Plots a Polyline using the current color and line style Parameter(s): x y x2 y2 ... Example: Polyline 10 10 20 10 30 40 Polyline 10 10 20 10 \ 30 40 Polyline 10 10 \ 20 10 \ 30 40 The backslash can be used at the end of the line to indicate that more x,y co-ordinates continue in the next line --------------------------------------------------------------------- Fill --------------------------------------------------------------------- Function: Flood fills the screen area with current fill color and pattern Parameter(s): x y BorderColor Example: Fill 10 10 15 Fill 10 10 White --------------------------------------------------------------------- LineStyle --------------------------------------------------------------------- Function: Sets the line style and thickness Parameter(s): style userpattern thickness Example: LineStyle 0 0 1 LineStyle SolidLn 0 NormWidth LineStyle DottedLn 0 ThickWidth Style Style Name -------------------- 0 SolidLn 1 DottedLn 2 CenterLn 3 DashedLn 4 CustomLn Thick Thickness Name --------------------- 1 NormWidth 3 ThickWidth If the style is set to a value of 4 (CustomLn) then the userpattern must contain a 16 bit pattern otherwise it should be set to 0. --------------------------------------------------------------------- FillStyle --------------------------------------------------------------------- Function: Sets the current fill style & fill color Parameter(s): style color Example: FillStyle 0 1 FillStyle SolidFill Blue Pattern Pattern Name ----------------------------------------------------------------- 0 EmptyFill 1 SolidFill 2 LineFill 3 LtSlashFill 4 SlashFill 5 BkSlashFill 6 LtBkslashFill 7 HatchFill 8 XHatchFill 9 InterleaveFill 10 WidedotFill 11 CloseDotFill 12 CustomFill --------------------------------------------------------------------- FillPattern --------------------------------------------------------------------- Function: Sets user defined custom fill pattern and color Parameter(s): c1 c2 c3 c4 c5 c6 c7 c8 color Example: FillPattern 128 128 128 128 128 128 128 128 1 FillPattern 128 128 128 128 128 128 128 128 Blue --------------------------------------------------------------------- Mouse --------------------------------------------------------------------- Function: Sets a rectangular hot mouse region Parameter(s): x y x2 y2 clk clr CommandText Example: Mouse 10 10 50 50 0 0 g^M Mouse 10 10 +40 +40 0 0 g^M NOTE: Refer to RipScrip Specs for clk and clr flags when using Mouse function with BBS screens. --------------------------------------------------------------------- KillMouseFields --------------------------------------------------------------------- Function: Erase all previously defined hot mouse regions from memory Parameter(s): none Example: KillMouseFields --------------------------------------------------------------------- BeginText --------------------------------------------------------------------- Function: Sets a rectangular text region Parameter(s): x y x2 y2 Example: BeginText 100 100 400 300 BeginText 100 100 +300 +200 --------------------------------------------------------------------- RegionText --------------------------------------------------------------------- Function: Prints a line of text in the previously defined text region and goes to the next line Parameter(s): Justify TextString Example: RegionText 0 Hello, this is an example of region text --------------------------------------------------------------------- EndText --------------------------------------------------------------------- Function: End a rectangular text region, no more RegionText commands. Parameter(s): none Example: EndText --------------------------------------------------------------------- GetImage --------------------------------------------------------------------- Function: Copies a rectangular area (upto 64K) of the screen to the clipboard. Parameter(s): x y x2 y2 Example: GetImage 0 0 50 50 GetImage 0 0 +50 +50 --------------------------------------------------------------------- PutImage --------------------------------------------------------------------- Function: Copies the clipboard contents to an area on the screen Parameter(s): x y mode Example: PutImage 10 10 0 PutImage 10 10 CopyPut PutImage 10 10 XorPut PutImage 10 10 AndPut PutImage 10 10 NotPut --------------------------------------------------------------------- WriteIcon --------------------------------------------------------------------- Function: Saves the contents of the clipboard to disk Parameter(s): filename Example: WriteIcon image.icn --------------------------------------------------------------------- LoadIcon --------------------------------------------------------------------- Function: Loads and displays an icon file Parameter(s): x y mode clipboard filename Example: LoadIcon 10 10 0 0 image.icn LoadIcon 10 10 CopyPut 0 image.icn LoadIcon 10 10 XorPut 1 image.icn If the clipboard parameter is set to 1 then the image is pasted on the screen AND also copied onto the Clipboard. --------------------------------------------------------------------- ButtonStyle --------------------------------------------------------------------- Function: Sets a new button style Parameter(s): none Example: ButtonStyle You can change the button style fields using the button style command followed by a dot and the field name and value. The fields that contain the "#" must contain numeric values, those with "ON/OFF" must contain the word "ON" or "OFF" ButtonStyle.Width # (def= 80) ButtonStyle.Height # (def= 30) ButtonStyle.Orient # (def= 2) ButtonStyle.BevSize # (def= 3) ButtonStyle.DFore # (def= 2) ButtonStyle.DBack # (def= 0) ButtonStyle.Bright # (def= 15) ButtonStyle.Dark # (def= 8) ButtonStyle.Surface # (def= 7) ButtonStyle.GroupNum # (def= 0) ButtonStyle.UlineCol # (def= 4) ButtonStyle.CornerCol # (def= 7) ButtonStyle.IconButton ON/OFF (def= OFF) ButtonStyle.PlainButton ON/OFF (def= ON) ButtonStyle.ClipButton ON/OFF (def= OFF) ButtonStyle.Mouse ON/OFF (def= OFF) ButtonStyle.Invertable ON/OFF (def= OFF) ButtonStyle.Reset ON/OFF (def= OFF) ButtonStyle.Chisel ON/OFF (def= ON) ButtonStyle.Recess ON/OFF (def= ON) ButtonStyle.Shadow ON/OFF (def= ON) ButtonStyle.Stamp ON/OFF (def= OFF) ButtonStyle.Bevel ON/OFF (def= ON) ButtonStyle.Underline ON/OFF (def= OFF) ButtonStyle.HotIcon ON/OFF (def= OFF) ButtonStyle.ADJ ON/OFF (def= OFF) ButtonStyle.RadioGroup ON/OFF (def= OFF) ButtonStyle.Sunken ON/OFF (def= ON) ButtonStyle.CheckBoxGroup ON/OFF (def= OFF) ButtonStyle.HighlightKey ON/OFF (def= OFF) ButtonStyle.Explode ON/OFF (def= OFF) ButtonStyle.LeftJustify ON/OFF (def= OFF) ButtonStyle.RightJustify ON/OFF (def= OFF) ButtonStyle.Selected ON/OFF (def= OFF) Width - Buttons width size Height - Buttons height size Orient - Button label orientation 0=Above button 1=Left of Button 2=Center 3=Right of Button 4=Below button BevSize - Buttons bevel size DFore - Text color for label DBack - Shadow color for label Bright - Left-Top color of the bevel Dark - Lower-Right color of the bevel Surface - Surface color of the button GroupNum - For BBS use, see RIPScrip specs UlineCol - Color used for Underline and marking Hotkeys CornerCol - Color used for button corners IconButton - Makes button use an Icon for the background PlainButton - Makes button plain, default setting ClipButton - Makes button use the contents of the clipboard as a background Mouse - Makes button able to accept input with a mouse or hotkey Invertable - Inverts button when selected Reset - Resets screen after button is selected Chisel - Give button a chisel look Recess - Give button a recess affect Shadow - Use Text shadow in button label Stamp - Copy button image to clipboard Bevel - Give button a bevel effect Underline - underline hotkey in button label HotIcon - Use alternative icon when icon button is selected ADJ - Adjust button label to fit properly RadioGroup - For BBS use, See RIPScrip specs Sunken - Give button a sunken effect CheckBoxGroup - For BBS use, see RIPScrip Spec HighlightKey - Highlight hot key Explode - Give button an explode effect when selected LeftJustify - Left justify button label RightJustify - Right justify button label Selected - Draw button already selected For more information on what these flags do please refer to the RipScrip protocol specifications. --------------------------------------------------------------------- Button --------------------------------------------------------------------- Function: Defines a Button Parameter(s): x y x2 y2 hotkey commandtext Example: Button 10 10 0 0 g <>GoodBye<>g^M Button 10 10 0 0 #103 <>GoodBye<>g^M Button 10 10 +40 +40 g <>GoodBye<>g^M Button 10 10 0 0 g image.icn<>GoodBye<>g^M This command requires that you issue a button style command before it can be used. The x2 and y2 parameters can be left to zero if you wish to use the size specified in the Button Style fields. For the hotkey you can use the actual letter or use the ascii value by placing the pound sign in front of the number. NOTE: The command text field actually contains three fields separated by <> characters. The first field contains the filename of an icon if the button is an icon button otherwise its left out. The second field begins after the <> separator, its the label for the button. The last field separated by another <> is the host command, it is what will be sent to the host when that button is pressed. When creating BBS screens the host command is simply a piece of text that tells the BBS what function to perform. When creating JMedia applications the host command can contain filenames and additional commands that can be executed. Refer to JMedia demos for usage. --------------------------------------------------------------------- Define --------------------------------------------------------------------- Function: Define a text variable Parameter(s): flag TextString Example: Define 1 text_var,60:?question?default data Refer to RipScrip Specs for additional information NOTE: This command is also used to store extended commands when creating JMedia applications. --------------------------------------------------------------------- Query --------------------------------------------------------------------- Function: Query the contents of a text variable Parameter(s): mode TextString Example: Query 0 this is a query $COMMAND$^m Refer to RipScrip specs for additional information --------------------------------------------------------------------- CopyRegion --------------------------------------------------------------------- Function: Copy screen portion up or down Parameter(s): x y x2 y2 destline Example: CopyRegion 0 0 639 39 60 NOTE: x and x2 parameters must be evenly divisible by 8. --------------------------------------------------------------------- ReadScene --------------------------------------------------------------------- Function: Display a local RIP file Parameter(s): filename Example: ReadScene file.RIP --------------------------------------------------------------------- FileQuery --------------------------------------------------------------------- Function: Query existing information on a particular file Parameter(s): mode filename Example: FileQuery 0 TEST.RIP Refer RipScrip specs for additional information --------------------------------------------------------------------- EnterBlockMode --------------------------------------------------------------------- Function: Enter block transfer mode with host Parameter(s): mode protocol filetype filename Example: EnterBlockMode 1 7 MENU.RIP Refer RipScrip specs for additional information --------------------------------------------------------------------- Wizard (MACRO COMMAND) --------------------------------------------------------------------- Function: Inserts a wizard object Parameter(s): x y x2 y2 filename Example: Wizard 10 10 100 100 METWIN.WIZ Wizard 10 10 +90 +90 METWIN.WIZ There are a number of wizard file that you can use wich contain the WIZ extension. You can even create your own wizard files. A Wizard file is a text containing simple one letter commands. c color - Sets the draw color S style color - Sets the Fill Style and Fill Color X x y - Plots a pixel in the current draw color F x y border - Paints an enclosed area at x,y stopping only when it encounters a pixel indicated by border L x y x2 y2 - Draw a line from x,y to x2,y2 R x y x2 y2 - Draw a rectangle from x,y to x2,y2 B x y x2 y2 - Draw a filled rectangle from x,y to x2,y2 o x y r1 r2 - Draw an ellipse at x,y with a radius of r1,r2 O x y r1 r2 - Draw a filled ellipse at x,y with a radius of r1,r2 Z x y x2 y2 x3 y3 x4 y4 segments - Draw a bezier curve When the variables x,y,x2,y2 are used with the command they will be substituted for the values entered with Wizard command at run time. The variable cx and cy represent the center position of the area specified. Study the sample WIZ files to get a better understanding on how to create your own WIZ files. --------------------------------------------------------------------- InsertIco (MACRO COMMAND) --------------------------------------------------------------------- Function: Inserts a Windows Ico file Parameter(s): x y filename Example: InsertIco 10 10 COMM.ICO --------------------------------------------------------------------- End (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Ends the current application and returns to text mode Parameter(s): none Example: End --------------------------------------------------------------------- TextColor (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Sets the text windows foreground color Parameter(s): Color Example: TextColor 2 TextColor Green --------------------------------------------------------------------- TextBackGround (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Sets the text windows background color Parameter(s): Color Example: TextBackGround 1 TextBackGround Blue The background color can only have values ranging from 0 to 7 --------------------------------------------------------------------- BTextColor (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Sets the foreground color for picklist hilight bar Parameter(s): Color Example: BTextColor 2 BTextColor Green --------------------------------------------------------------------- BTextBackGround (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Sets the background color for the picklist hilight bar Parameter(s): Color Example: BTextBackGround 1 BTextBackGround Blue --------------------------------------------------------------------- AddHotKey (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Adds a hot key Parameter(s): Key CommandString Example: AddHotKey e EXIT^M AddHotKey #32 EXIT^M AddHotKey ^A EXIT^M The key parameter can entered in ascii code format by adding a pound sign in front of the number. Control codes can also be entered by adding a caret in front of the letter. Control codes can only range from A to Z. --------------------------------------------------------------------- ReMapKey (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Remaps a hot key with another hot key Parameter(s): OldKey NewKey Example: ReMapKey e d ReMapKey #32 #65 ReMapKey ^A ^B ReMapKey ^A #66 ReMapKey ^A B The key parameter can entered in ascii code format by adding a pound sign in front of the number. Control codes can also be entered by adding a caret in front of the letter. Control codes can only range from A to Z. The RemapKey function can also be used to overwrite the default keys for selecting buttons using the keyboard. The Tab key can be reassigned using : ReMapKey NEXT NewKey The Shift-Tab key can be reassigned using: ReMapKey PREVIOUS NewKey The Enter key can be reassigned using : ReMapKey ENTER NewKey The Esc key can be reassigned using : ReMapKey ABORT NewKey The NewKey must be in entered using the pound sign and using an extended ascii code. These codes are listed in ASCII.TXT or simply use the CODE.EXE program. --------------------------------------------------------------------- Delay (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Delays a specified number of milliseconds Parameter(s): milliseconds Example: Delay 2000 1000 milliseconds equals roughly 1 second --------------------------------------------------------------------- CommandDelay (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Sets the delay period to be executed after each command Parameter(s): milliseconds Example: CommandDelay 50 --------------------------------------------------------------------- ExecuteList (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Executes a text file which contains series of extended commands Parameter(s): filename Example: ExecuteList CMD.TXT --------------------------------------------------------------------- Push (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Pushes a command into JMedia's command stack, last in first out (LIFO). The ^M is used as a command separator and terminator Parameter(s): command Example: Push PLAY abc^M --------------------------------------------------------------------- Pop (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Removes the last command from JMedia's command stack Parameter(s): none Example: Pop --------------------------------------------------------------------- ClearStack (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Erases all the commands from JMedia's command stack Parameter(s): none Example: ClearStack --------------------------------------------------------------------- Sound (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Starts generating a sound at specified frequency Parameter(s): frequency Example: Sound 400 --------------------------------------------------------------------- NoSound (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Shuts the sound off Parameter(s): none Example: NoSound --------------------------------------------------------------------- NoSound (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Shuts the sound off Parameter(s): none Example: NoSound --------------------------------------------------------------------- Play (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Plays a series of musical notes. Uses the same format as QBasic's PLAY command. Parameter(s): notes Example: Play abc --------------------------------------------------------------------- Screen (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Selects a new screen mode Parameter(s): mode Example: Screen 1 There are 14 screen modes to choose from, depending on your display card some of these modes might not be available. It is important to try and determine which modes your display card can support before using them in a JMedia application. If your display card cannot display a certain mode it can cause JMedia to crash. Mode Resolution ------------------- 0 640x200x16 1 640x350x16 2 640x480x16 3 320x200x16 4 640x200x16 5 640x350x16 6 640x480x16 7 800x600x16 8 1024x768x16 9 320x200x256 10 640x400x256 11 640x480x256 12 800x600x256 13 1024x768x256 --------------------------------------------------------------------- RestoreCrtMode (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Returns to Text Mode Parameter(s): none Example: RestoreCrtMode --------------------------------------------------------------------- Execute (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Executes an external file or shells to DOS Parameter(s): none or filename Example: Execute Execute GAME.EXE --------------------------------------------------------------------- StuffString (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Stuffs the keyboard buffer with characters Parameter(s): characters Example: StuffString hello --------------------------------------------------------------------- ClearKbdBuffer (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Clears the keyboard buffer Parameter(s): none Example: ClearKbdBuffer --------------------------------------------------------------------- KbdToStack (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Copies the keyboard buffer contents to JMedia's command stack Parameter(s): none Example: KbdToStack --------------------------------------------------------------------- MBRelease (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Sets an internal flag that informs JMedia how to handle button commands when pressed. When set to "ON" JMedia will wait for the mouse button to be released before continuing. Parameter(s): ON/OFF Example: MBRelease ON MBRelease OFF --------------------------------------------------------------------- CharCase (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Sets an internal flag that informs JMedia how to handle hot keys. If CharCase is set to "ON" than the key pressed must be exactly the same, in other words case sensitive. Parameter(s): ON/OFF Example: CharCase ON CharCase OFF --------------------------------------------------------------------- Cursor (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Toggles the cursor in the Text Window ON or OFF Parameter(s): ON/OFF Example: Cursor ON Cursor OFF --------------------------------------------------------------------- Ansi (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Sets the ansi flag to ON or OFF. This command must be used before a TextWindow command. Parameter(s): ON/OFF Example: Ansi ON Ansi OFF --------------------------------------------------------------------- MouseState (EXTENDED COMMAND) --------------------------------------------------------------------- Function: This command tells JMedia to enable/disable mouse input. This command has no effect if a Mouse is not detected. Parameter(s): ON/OFF Example: MouseState ON MouseState OFF --------------------------------------------------------------------- InvertArea (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Inverts a rectangular area on the screen Parameter(s): x y x2 y2 XorColor Example: InvertArea 10 10 100 100 15 InvertArea 10 10 +90 +90 White --------------------------------------------------------------------- ShowPcx (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Displays a PCX image Parameter(s): x y name pal Example: ShowPcx 10 10 image.pcx YES ShowPcx 10 10 image.pcx NO --------------------------------------------------------------------- ShowPcxFile (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Displays an external PCX file image Parameter(s): x y name pal Example: ShowPcx 10 10 image.pcx YES ShowPcx 10 10 image.pcx NO NOTE: When using this command from JMedia's IDE it behaves the same way as the ShowPcx function. The difference is when you create an executable file using these two commands. The ShowPcx function will search the executable for the PCX image but the ShowPcxFile will search for a PCX file. --------------------------------------------------------------------- Browse (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Displays a text file using Browser sub-commands Parameter(s): filename Example: Browse README.TXT This function cannot work by itself, additional setup steps must be taken. 1) A text window must be defined. This creates the area and selects the font the browser will use to display the text file contents. See TextWindow function. 2) Button commands/hot keys must issued containing browser sub-commands. These sub-commands tell the browser to do simple things such as page up/down, home/end, and other functions you would normally find in a text file browser. You can use all the browser sub-commands or as many as you want. This allows you to truly create custom looking applications. See Button function. 3) You can use the TextColor and TextBackGround functions to select the text colors the browser will be using. Available browser sub-commands are CASE sensitive, they must be entered exactly as listed. PGUP PGDOWN HOME END MOVEUP MOVEDOWN GOTOLINE SAVEPOS RESTOREPOS EXIT --------------------------------------------------------------------- PickList (EXTENDED COMMAND) --------------------------------------------------------------------- Function: Displays a picklist file using picklist sub-commands Parameter(s): filename Example: PickList CMD.TXT You must set up the picklist command the way you set up the browser command. There are two additional commands required for the picklist, the BTextColor and BTextBackGround. These set the colors for the select bar. A picklist file is simply a file containing a series of item descriptions followed by a command to issue once that item has been selected. Item descriptions and commands are separated using <> characters. A sample picklist file might look like this: Introduction <>intro.rip^M Installation <>instal.rip^M Requirements <>req.rip^M Available picklist sub-commands are CASE sensitive, they must be entered exactly as listed. You must assign one button or hot key with the accept command, this will add the item command to JMedia's stack and exit the picklist object. ACCEPT SCROLLUP SCROLLDOWN PGUP PGDOWN HOME END MOVEUP MOVEDOWN GOTOLINE SAVEPOS RESTOREPOS EXIT